Inside Macintosh: QuickDraw GX Printing /

Chapter 3 - Page Formatting and Dialog Box Customization / Page Formatting and Dialog Box Customization Reference

Functions / Manipulating Format Object Properties

GXSetFormatForm

You can use the GXSetFormatForm function to associate the form and mask shapes with a specific format object.

void GXSetFormatForm (gxFormat aFormat, gxShape form, 
                        gxShape mask);

aFormat

A reference to the format object in which to associate the form and mask shapes.

form

A reference to a picture shape that specifies the form to assign to a format object.

mask

A reference to a picture shape that specifies the mask to assign to a format object.

DESCRIPTION

The GXSetFormatForm function replaces any form previously associated with a particular format object. It increments the owner counts of the new picture shapes (by calling the GXCloneShape function) and decrements the owner counts of the old picture shapes (by calling the GXDisposeShape function).

You may set either the form parameter or the mask parameter to nil.

Picture shapes are flattened to disk with the format object during spooling. To retrieve the form and mask shapes for a particular format object, you use the GXGetFormatForm function.

RESULT CODES

gxSegmentLoadFailedErr

A required code segment could not be found, or there was not enough memory to load it.

SEE ALSO

Listing 3-12 on page 3-51 shows how to use the GXSetFormatForm function to associate the form and mask shapes with a specific format object.

To obtain the form shape associated with a format object, see the description of the GXGetFormatForm function in the previous section.

Main | Page One | What's New | Apple Computer, Inc. | Find It | Contact Us | Help